KS_CUSTOMERS
Ordinal |
Description |
PK
for |
SQL Table |
SQL Column |
FK Table |
Check
|
Comments |
---|---|---|---|---|---|---|---|
1 |
Customer Number |
Y |
business_entity |
business_xref_id |
|
|
Must be unique to the ERP system |
2 |
KommerceServer ID |
[Y] |
business_entity |
business_no |
|
|
This is the KommerceServer reference number for this customer. It is only needed when the customer was originally created in KS as a cross reference to the customer number assigned by the ERP system when imported. |
3 |
Business Type |
|
business_entity |
business_type |
|
'C' = customer |
Vendors, prospects, and end users reside in same table with different types |
4 |
Customer Name |
|
business_entity |
business_name |
|
|
The name for the customer, vendor, prospect, or end user as it relates to the business type. |
5 |
Address Line 1 |
|
entity_address |
address_line1 |
|
|
There is only one address which can be sent for each unique customer which is flagged in the SQL DB as the primary or corporate address. Addition location addresses are sent up separately via the KS_SHIP_ADDRS data feed. The Country is a free form string but for best results, send up the ISO standard 2-character country code. KommerceServer will match this to an internal table so that the country can be maintained through a drop down list when adding or updating address locations. |
6 |
Address Line 2 |
|
entity_address |
address_line2 |
|
|
|
7 |
Address Line 3 |
|
entity_address |
address_line3 |
|
|
|
8 |
City |
|
entity_address |
city |
|
|
|
9 |
State |
|
entity_address |
state_prov_cd |
|
|
|
10 |
Zip Code |
|
entity_address |
zip_postal |
|
|
|
11 |
Country |
|
entity_address |
country |
|
|
|
12 |
Phone |
|
entity_address |
phone_no |
|
|
|
13 |
|
entity_address |
wh_plant_cd |
warehouse_plant |
|
The site or warehouse codes will be created if they don’t exist. They are also defined in the KS_INVENTORY export |
|
14 |
|
warehouse_plant |
wh_plant_name |
|
|
|
|
15 |
Website |
|
business_entity |
website |
|
|
The customer's website URL. This is a linkable field in KommerceServer so it should be fully qualified URL |
16 |
Credit Limit |
|
business_entity |
credit_limit |
|
|
Display only reference field |
17 |
Terms Type XREF |
|
payment_terms |
terms_xref_id |
payment_terms |
|
Cross reference value (e.g. 2/5/30); A payment term will be created if it does not exist. |
18 |
KS Term Type |
|
payment_terms |
term_type |
|
'STD'=Standard 'PREPAID'= Prepaid |
If 'PREPAID' type the discount term fields below can be null; If 'STDX' is used then the breakdown fields do not need to be supplied (e.g. discount day, discount %, etc.) |
19 |
Discount Days |
|
payment_terms |
discount_days |
|
|
The max number of days aged before discount expires (STD type) |
20 |
Discount Day of Month |
|
payment_terms |
discount_dom |
|
|
The day of the following month when discount can be taken (PROX type) |
21 |
Discount Percent |
|
payment_terms |
discount_pct |
|
|
Discount percentage (factor) if paid early |
22 |
Discount Net Days |
|
payment_terms |
net_days |
|
|
If not paid early, the days when the net balance will be due (STD type) |
23 |
Net Discount Day of Month |
|
payment_terms |
net_dom |
|
|
If not paid early, the day of the next month when balance will be due (PROX) |
24 |
Taxable |
|
business_entity |
taxable_flg |
|
'Y'
= Taxable |
If Non-Taxable, then tax will never be computed on orders regardless of where it is shipping |
25 |
Tax Code |
|
entity_address |
tax_cd |
tax_code |
|
FK Table sent by KS_SALES_TAX export |
26 |
Master Reference Id |
|
business_entity |
master_ref_id |
|
|
Used to logically group multiple customers into one virtual customer |
27 |
Y |
business_salesrep |
salesrep_id |
|
|
Sales reps show as links on website only if there is a corresponding contact exported with this sales rep code. |
|
28 |
Currency Code |
|
business_entity |
currency_cd |
currency_code |
|
If NULL, the functional currency of the website is assumed |
29 |
Bill To Customer Number |
|
business_entity |
bill_to_business_no |
business_entity |
|
Self reference FK which means the bill to customer also needs to be sent in the same data export as the rest of the customers (Business Type = 'C') |
30 |
Region |
|
entity_address |
region_no |
region |
|
Refer to KS_REGIONS export |
31 |
Customer Class |
Y |
business_class |
class_no, |
classification |
|
Refer to KS_CLASSIFICATIONS export |
32 |
Credit Hold |
|
business_entity |
hold_cd |
|
|
A Non-null value indicates the customer is on Hold |
33 |
Price Sheet Code |
|
entity_address |
price_sheet_cd |
|
|
When determining item prices in the storefront this is used to identify customer specific pricing. A Price Sheet Code can be any string but should represent how your ERP system organizes pricing. For example, if by country you may opt to send in the ISO country code. If your system has this concept it is best to send in a relevant value. For example, if there is a branch where pricing is derived then send in the branch identifier. KommerceServer does not care what this value is but it will use this as a first-level filter when looking up customer pricing. |
34 |
Price Basis Code |
|
entity_address |
price_basis_cd |
|
|
A secondary filter can be used for customer-specific price lookups. There can be more than one Price Basis per Price Sheet (e.g. LIST, WHOLESALE, MSRP, COST, etc.). If your ERP just has one price per Price Sheet, then use a meaningful term like LIST or BASE for this field. This field can be left blank but if there are more 1 price defined for a Price Sheet it will be ambiguous so pricing cannot be determined. |
35 |
Matrix Group Values |
|
customer_price_group |
group_cd, |
|
Use
"&" to delimit between pairs and use "=" to match |
This
is a JSON formatted string of named value pairs which will be parsed and
optimized exclusively for the purposes of price matrix selection. Any
associated group value that may participate in a price matrix should be
included for the customer. For example, if you provide price matrix discounts
based on a specific class of customer, specific customer, a specific region,
or zip code, the string may look like: |
36 |
Access Group Codes |
|
access_group_business |
access_group_cd |
|
|
Specifies the Access Group Code for the customer. |
37 |
Default Ship Via |
|
entity_address |
default_ship_via_cd |
|
|
Indicates a default Ship Via code for the customer. During checkout in the Store is there is a freight method that is associated to this ship via code, it will be the default. |
38 |
Free Shipping Minimum |
|
entity_address |
free_shipping_minimum_amt |
|
|
Indicates a minimum dollar amount required for free shipping for this customer. Only those freight methods that are eligible for a customer-specific minimum will this feature be applied. Note: You must send up a number greater then 0 for this feature to be active. |
39 |
Allow Shipments |
|
entity_address |
allow_shipments_flg |
|
'Y' or 'N' |
If 'Y' then this address will be available during checkout to choose as a shipping destination. A 'N' value will exclude this address, typically for a PO Box address. |